Command Chaining Command

Command:

Command Chaining allows multiple commands to be sent as a bundle.

Notes:

This command allows the host to bundle up to 99 HSM commands together (called sub-commands), and send them to the HSM in one command message. The HSM will extract the sub-commands, execute them individually (as if sent independently by the host), and bundle up the responses. The HSM will then send the bundled responses back to the host in one response message.

Field

Length & Type

Details

COMMAND MESSAGE

Message Header

m A

Will be returned to the Host unchanged

Command Code

2 A

Value “NK”

Message Header Flag

1 N

0 – Commands don’t have message headers.

1 – Commands have individual message headers.

Number of commands

2 N

Number of commands to follow (min 01, max 99).

Sub-Command #1

Length

4 N

Size of remaining fields in this sub-command.

Message Header

m A

Only present if Message Header Flag is 1.

Command Code

2 A

Parameters

?

Input parameters, as appropriate to the specified command.

Sub-Command #2

Length

4 N

Size of remaining fields in this sub-command.

Message Header

m A

Only present if Message Header Flag is 1.

Command Code

2 A

Parameters

?

Input parameters, as appropriate to the specified command.

“

“

“

“

“

“

Sub-Command #N

Length

4 N

Size of remaining fields in this sub-command.

Message Header

m A

Only present if Message Header Flag is 1.

Command Code

2 A

Parameters

?

Input parameters, as appropriate to the specified command.

End Message Delimiter

1 C

Optional. Must be present if a message trailer is present. Value X'19.
 

Message Trailer

n A

Optional. Maximum length 32 characters.
 

Field

Length & Type

Details

RESPONSE MESSAGE

Message Header

m A

Will be returned to the Host unchanged.

Response Code

2 A

Value “NL”

Error Code

2 N

00 : No error
15 : Error in input data
51 : Invalid Message Header Flag field
52 : Invalid Number of Commands field
53 : Invalid Length field within sub-command

Number of commands

2 N

Number of commands to follow.

Sub-Command #1

Length

4 N

Size of remaining fields in this sub-command.

Message Header

m A

Only present if Message Header Flag is 1.

Response Code

2 A

Error Code

2 N

Error codes are appropriate to the specified command.

Output Parameters

?

Output parameters, as appropriate to the specified command.

Sub-Command #2

Length

4 N

Size of remaining fields in this sub-command.

Message Header

m A

Only present if Message Header Flag is 1.

Response Code

2 A

Error Code

2 N

Error codes are appropriate to the specified command.

Output Parameters

?

Output parameters, as appropriate to the specified command.

“

“

“

“

“

“

Sub-Command #N

Length

4 N

Size of remaining fields in this sub-command.

Message Header

m A

Only present if Message Header Flag is 1.

Response Code

2 A

Error Code

2 N

Error codes are appropriate to the specified command.

Output Parameters

?

Output parameters, as appropriate to the specified command.

End Message Delimiter

1 C

Will only be present if present in the command message. Value X'19.
 

Message Trailer

n A

Will only be present if present in the command message. Maximum length 32 characters.